wfm-ux

1.0.x
(0 reviews)

NonTMF-Update Service Geo Coordinates

This operation allows to update the service geo coordinates for JM.

Key Considerations common for both FTTH and HFC Implementation

  1. All the fields except uniqueId in the input payload are mandatory in order to update Service Geo Coordinates for FTTH services.
  2. serviceNumber should be mandatory and must be in the format of "8767775772". We should not add +1 to the serviceNumber for voice services. For other service types please send as is.
  3. For WFM project, please pass the channelId as "WFM".
  4. propertyType value must be "Service" in order to update the service geo coordinates.

Key Considerations for FTTH Implementation

  1. We have to pass the valid uniqueServiceId of the given serviceNumber in input. In case of empty value, then additional processing logic has been added to retrieve the uniqueServiceId for the given serviceNumber from the TMF638 List Services response. To improve the performance, we always recommend passing uniqueId(uniqueServiceId) from input if we have.
  2. We recommend passing the Liberate User or employeeId (this has to be configured in liberate systems) in input payload for respective markets, if not then ESB will assign a default value to update service properties.
  3. propertyValuesGroup array must be passed. At least it should contain a valid service property object with proper id and value details in order to proceed with update operation.If the propertyId doesn't matches with the liberate configured property, then below error will be throned."Property mismatch: Provided property(s) do not match liberate configuration."

Key Considerations for Cerillion HFC Implementation

  1. As part of HFC implementation, uniqueId (i.e., externalAddressUid) is not required to send in input.
  2. propertyValuesGroup array must be passed. At least it should contain a valid service property object with proper id and value details in order to proceed with update operation. Only allowed service properties are "X_COORDINATE" and "Y_COORDINATE"
URL
https://nonprod.esb.cloud.lla.com/test/wfm-ux/wfm-ux/v1/{businessId}/accounts/{accountNo}/properties
URI Params
nametypedescriptionrequired
businessIdstring2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) identifying the business unit.Y
accountNostringbilling account numberY
Headers
nametypedescriptionrequired
client_idstringThe client_id identifying the channel. Minimum characters: 5Y
client_secretstringPassword associated with the client_id. Minimum characters: 5Y
X-Correlation-IDstringIdentifier that correlates HTTP request between a client and server.
Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction.		Y
cURL request for FTTH - Liberate
Request with UniqueId
curl --location --request PATCH 'https://nonprod.esb.cloud.lla.com/test/wfm-ux/wfm-ux/v1/JM/account/317918910000/properties' \
--header 'client_id: 123' \
--header 'client_secret: 123' \
--header 'X-Correlation-ID: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b' \
--header 'Content-Type: application/json' \
--data '{
    "serviceNumber": "8767775772",
    "uniqueId": "71277953",
    "channelId": "WFM",
    "employeeId": "23456",
    "propertyType": "Service",
    "propertyValuesGroup": [
        {
            "propertyId": "X_COORDINATE",
            "propertyValue": "12349"
        },
        {
            "propertyId": "Y_COORDINATE",
            "propertyValue": "34569"
        }
    ]
}'
Request without UniqueId
curl --location --request PATCH 'https://nonprod.esb.cloud.lla.com/test/wfm-ux/wfm-ux/v1/JM/account/317918910000/properties' \
--header 'client_id: 123' \
--header 'client_secret: 123' \
--header 'X-Correlation-ID: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b' \
--header 'Content-Type: application/json' \
--data '{
    "serviceNumber": "8767775772",
    "uniqueId": "",
    "channelId": "WFM",
    "employeeId": "23456",
    "propertyType": "Service",
    "propertyValuesGroup": [
        {
            "propertyId": "X_COORDINATE",
            "propertyValue": "12349"
        },
        {
            "propertyId": "Y_COORDINATE",
            "propertyValue": "34569"
        }
    ]
}'
Response for Liberate
{
    "serviceNumber": "8767775772",
    "uniqueId": "71277953",
    "channelId": "WFM",
    "employeeId" : "23456",
    "propertyType": "Service",
    "propertyValuesGroup": [
        {
            "propertyId": "X_COORDINATE",
            "propertyValue": "12349"
        },
        {
            "propertyId": "Y_COORDINATE",
            "propertyValue": "34569"
        }
    ]
}
cURL request for HFC- Cerillion
curl --location --request PATCH 'https://nonprod.esb.cloud.lla.com/test/wfm-ux/wfm-ux/v1/JM/accounts/50000627/properties' \
--header 'client_id: 123' \
--header 'client_secret: 123' \
--header 'X-Correlation-ID: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b' \
--header 'Content-Type: application/json' \
--data '{
    "serviceNumber": "8769129455",
    "channelId": "WFM",
    "propertyType": "Service",
    "propertyValuesGroup": [
        {
            "propertyId": "X_COORDINATE",
            "propertyValue": "72° 52 99.3 N"
        },
        {
            "propertyId": "Y_COORDINATE",
            "propertyValue": "79° 42 76.3 E"
        }
    ]
}'
Response for HFC- Cerillion
{
    "serviceNumber": "8769129455",
    "uniqueId": "822301",
    "channelId": "WFM",
    "propertyType": "Service",
    "propertyValuesGroup": [
        {
            "propertyId": "X_COORDINATE",
            "propertyValue": "72° 52 99.3 N"
        },
        {
            "propertyId": "Y_COORDINATE",
            "propertyValue": "79° 42 76.3 E"
        }
    ]
}

Reviews